RemoveAxisFromGroup

Removes an axis from a group. The command can't be buffered. If there is no axis left in the group, the state changes to GroupDisabled.

Syntax

KsError RemoveAxisFromGroup(
     int Index,
     int IndexInGroup
);

Parameters

Index [in]: the index of an axis group. Indexes are zero based. You can have up to 32 groups.

IndexInGroup [in]: the index of an axis in the group.

Return value

If the function succeeds, it returns errNoError, otherwise an error code. For more information about the error code, see the KsError list.

Remarks

If sent to a group that is not in GroupDisabled, GroupStandstill or GroupErrorStop, it generates an error and the function is not executed.

Example

N/A

Requirements

  RT Win32
Minimum supported version 4.0 4.0
Header ksmotion.h ksmotion.h
Library KsApi_Rtss.lib KsApi.lib

See also

AddAxisToGroup

UngroupAllAxes